<?php
    /**
     * Created by PhpStorm.
     * User: zgh
     * Date: 2021-08-06
     * Time: 10:03
     */

    namespace app\api\apidoc;

    use hg\apidoc\annotation as Apidoc;


    class NewsDoc
    {
        /**
         * @Apidoc\Param("page", type="int",default="1" ,desc="页码" )
         * @Apidoc\Param("limit", type="int",default="10",desc="每页数量" )
         * @Apidoc\Param("type", type="int",desc="所属模块" )
         * @Apidoc\Returned("total", type="int",desc="总共条数" )
         * @Apidoc\Returned("dataList",type="object",desc="列表",
         *     @Apidoc\Returned ("id",type="int",desc="ID"),
         *     @Apidoc\Returned ("type",type="int",desc="所属模块"),
         *     @Apidoc\Returned ("brief",type="string",desc="简介"),
         *     @Apidoc\Returned ("images",type="string",desc="封面图"),
         *     @Apidoc\Returned ("publish_time",type="string",desc="发布时间"),
         * )
         */
        public function get_list()
        {
        }


        /**
         * @Apidoc\Param("id", type="int",require=true ,desc="资讯id" )
         * @Apidoc\Returned ("id",type="int",desc="ID"),
         * @Apidoc\Returned ("type",type="int",desc="所属模块"),
         * @Apidoc\Returned ("brief",type="string",desc="简介"),
         * @Apidoc\Returned ("images",type="string",desc="封面图"),
         * @Apidoc\Returned ("publish_time",type="string",desc="发布时间"),
         * @Apidoc\Returned ("content",type="string",desc="详情内容"),
         * @Apidoc\Returned ("read_num",type="string",desc="阅读数"),
         */
        public function get_detail()
        {
        }


        /**
         * @Apidoc\Param("id", type="int",require=true ,desc="资讯id" )
         */
        public function share(){

        }
    }